<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.3.1"/>
<title>EnTech FPK: StateDoneCode Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">EnTech FPK
   &#160;<span id="projectnumber">1</span>
   </div>
   <div id="projectbrief">FRC Programming Kit by the EnTech 281 GreenVillains</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.3.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Enumerator</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="class_state_done_code-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">StateDoneCode Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p><code>#include &lt;<a class="el" href="_state_done_code_8hpp_source.html">StateDoneCode.hpp</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a0131781cf44a425a9d7b72dc74c9f5aa"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0131781cf44a425a9d7b72dc74c9f5aa"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>StateDoneCode</b> (int code)</td></tr>
<tr class="separator:a0131781cf44a425a9d7b72dc74c9f5aa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad4e348045601f6626fde9d66968a27a7"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad4e348045601f6626fde9d66968a27a7"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>StateDoneCode</b> (const <a class="el" href="class_state_done_code.html">StateDoneCode</a> &amp;code)</td></tr>
<tr class="separator:ad4e348045601f6626fde9d66968a27a7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:add0a0fb7ac5626867698375c3eea7f5b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="add0a0fb7ac5626867698375c3eea7f5b"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>GetCode</b> () const </td></tr>
<tr class="separator:add0a0fb7ac5626867698375c3eea7f5b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad1900d7c280f39a4abd2a4229a9fec57"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad1900d7c280f39a4abd2a4229a9fec57"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>IsDone</b> () const </td></tr>
<tr class="separator:ad1900d7c280f39a4abd2a4229a9fec57"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acad7202f96e292d5c3ae5d306d0d8500"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acad7202f96e292d5c3ae5d306d0d8500"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>IsError</b> () const </td></tr>
<tr class="separator:acad7202f96e292d5c3ae5d306d0d8500"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae004e125dbfabe22c2194fa5dfd9033b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae004e125dbfabe22c2194fa5dfd9033b"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>operator==</b> (<a class="el" href="class_state_done_code.html">StateDoneCode</a> other) const </td></tr>
<tr class="separator:ae004e125dbfabe22c2194fa5dfd9033b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac9988218e92e6ab4913d22e8fd654e47"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac9988218e92e6ab4913d22e8fd654e47"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>operator!=</b> (<a class="el" href="class_state_done_code.html">StateDoneCode</a> other) const </td></tr>
<tr class="separator:ac9988218e92e6ab4913d22e8fd654e47"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a63b3a8aa8483a92e37ce7498d2772513"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a63b3a8aa8483a92e37ce7498d2772513"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>operator&lt;</b> (<a class="el" href="class_state_done_code.html">StateDoneCode</a> other) const </td></tr>
<tr class="separator:a63b3a8aa8483a92e37ce7498d2772513"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a56826853af362da2db4b1aaa1a6b6b3c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a56826853af362da2db4b1aaa1a6b6b3c"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>operator&gt;</b> (<a class="el" href="class_state_done_code.html">StateDoneCode</a> other) const </td></tr>
<tr class="separator:a56826853af362da2db4b1aaa1a6b6b3c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a510f9f34266163b92ff9927da69e39ce"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a510f9f34266163b92ff9927da69e39ce"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>operator&lt;=</b> (<a class="el" href="class_state_done_code.html">StateDoneCode</a> other) const </td></tr>
<tr class="separator:a510f9f34266163b92ff9927da69e39ce"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9471edc62438b5ae7537f982a689cd61"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9471edc62438b5ae7537f982a689cd61"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>operator&gt;=</b> (<a class="el" href="class_state_done_code.html">StateDoneCode</a> other) const </td></tr>
<tr class="separator:a9471edc62438b5ae7537f982a689cd61"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:abebdd80075060f0e45d6aca85b7c5b3d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abebdd80075060f0e45d6aca85b7c5b3d"></a>
static <a class="el" href="class_state_done_code.html">StateDoneCode</a>&#160;</td><td class="memItemRight" valign="bottom"><b>GetNotYetCode</b> ()</td></tr>
<tr class="separator:abebdd80075060f0e45d6aca85b7c5b3d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a987fb089d47b6453c2083050c195bba4"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a987fb089d47b6453c2083050c195bba4"></a>
static <a class="el" href="class_state_done_code.html">StateDoneCode</a>&#160;</td><td class="memItemRight" valign="bottom"><b>GetSuccessCode</b> ()</td></tr>
<tr class="separator:a987fb089d47b6453c2083050c195bba4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5e6cb8a9ccafdff6fcbf9d4b31656f6c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5e6cb8a9ccafdff6fcbf9d4b31656f6c"></a>
static <a class="el" href="class_state_done_code.html">StateDoneCode</a>&#160;</td><td class="memItemRight" valign="bottom"><b>GetNotDoneCode</b> ()</td></tr>
<tr class="separator:a5e6cb8a9ccafdff6fcbf9d4b31656f6c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a87c673ffbc1141b7e217f3022ade82bf"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a87c673ffbc1141b7e217f3022ade82bf"></a>
static <a class="el" href="class_state_done_code.html">StateDoneCode</a>&#160;</td><td class="memItemRight" valign="bottom"><b>GetGenericErrorCode</b> ()</td></tr>
<tr class="separator:a87c673ffbc1141b7e217f3022ade82bf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a697fa5e3a37f7436919773feacf0870a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a697fa5e3a37f7436919773feacf0870a"></a>
static <a class="el" href="class_state_done_code.html">StateDoneCode</a>&#160;</td><td class="memItemRight" valign="bottom"><b>GetCancelErrorCode</b> ()</td></tr>
<tr class="separator:a697fa5e3a37f7436919773feacf0870a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a7160df862da838ecab09f094684c75a1"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7160df862da838ecab09f094684c75a1"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>m_code</b></td></tr>
<tr class="separator:a7160df862da838ecab09f094684c75a1"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>The <a class="el" href="class_state_done_code.html">StateDoneCode</a> class is used as an exit code for States.</p>
<p>The <a class="el" href="class_state.html">State</a> class finishs by setting a <a class="el" href="class_state_done_code.html">StateDoneCode</a> other than "NotDone".</p>
<p>Code -1 is reserved to indicate that the <a class="el" href="class_state.html">State</a> is not done yet. Codes [0, Inf) indicates an end result expected in a perfectly working program. Code 0 is reserved to indicate general success. Code 1 is reserved to indicate simply "not yet". Useful for something like a "CheckSensorState". Codes (-Inf, -2] indicates an error. Code -2 indicates a generic error. Code -3 indicates that the operation was canceled in an unintended manner. The entire range [-0x0A, 0x0A] is reserved to be definied by FPK. The rest of the codes may be defined anyway you like. </p>
</div><hr/>The documentation for this class was generated from the following files:<ul>
<li>C:/Users/Sam/Projects/FRC/Libraries/Fpk/Entech-Fpk-Subscribers/Entech-Fpk/<a class="el" href="_state_done_code_8hpp_source.html">StateDoneCode.hpp</a></li>
<li>C:/Users/Sam/Projects/FRC/Libraries/Fpk/Entech-Fpk-Subscribers/Entech-Fpk/StateDoneCode.cpp</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Aug 12 2013 16:46:51 for EnTech FPK by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.3.1
</small></address>
</body>
</html>
